<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Get follower info API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'ccr-get-follow-info.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ccr-get-follow-info.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ccr-get-follow-info.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/ccr-get-follow-info.html" rel="nofollow" target="_blank">../en/ccr-get-follow-info.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="ccr-apis.html">Cross-cluster replication APIs</a></span>
»
<span class="breadcrumb-node">Get follower info API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="ccr-get-follow-stats.html">« Get follower stats API</a>
</span>
<span class="next">
<a href="ccr-put-auto-follow-pattern.html">Create auto-follow pattern API »</a>
</span>
</div>
<div class="section xpack">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="ccr-get-follow-info"></a>Get follower info API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-info.asciidoc">edit</a><a class="xpack_tag" href="https://www.elastic.co/subscriptions"></a>
</h2>
</div></div></div>

<p>Retrieves information about all follower indices.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-info-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-info.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /&lt;index&gt;/_ccr/info</pre>
</div>
<div class="console_widget" data-snippet="snippets/1440.console"></div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-info-prereqs"></a>Prerequisites<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-info.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
If the Elasticsearch security features are enabled, you must have <code class="literal">monitor</code> cluster
privileges. For more information, see <a class="xref" href="security-privileges.html" title="Security privileges">Security privileges</a>.
</li>
</ul>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-info-desc"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-info.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This API lists the parameters and the status for each follower index.
For example, the results include follower index names, leader index names,
replication options and whether the follower indices are active or paused.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-info-path-parms"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-info.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;index&gt;</code>
</span>
</dt>
<dd>
(Required, string) A comma-delimited list of follower index patterns.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-info-response-body"></a>Response body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-info.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This API returns the following information:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">follower_indices</code>
</span>
</dt>
<dd>
(array) An array of follower index statistics.
</dd>
</dl>
</div>
<p>The <code class="literal">indices</code> array consists of objects containing several fields:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">indices[].follower_index</code>
</span>
</dt>
<dd>
(string) The name of the follower index.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].remote_cluster</code>
</span>
</dt>
<dd>
(string) The <a class="xref" href="modules-remote-clusters.html" title="Remote clusters">remote cluster</a> that contains the
leader index.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].leader_index</code>
</span>
</dt>
<dd>
(string) The name of the index in the leader cluster that is followed.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].status</code>
</span>
</dt>
<dd>
(string) Whether index following is <code class="literal">active</code> or <code class="literal">paused</code>.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].parameters</code>
</span>
</dt>
<dd>
(object) An object that encapsulates cross-cluster replication parameters.
</dd>
</dl>
</div>
<p>The <code class="literal">parameters</code> contains the following fields:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">indices[].parameters.max_read_request_operation_count</code>
</span>
</dt>
<dd>
(integer) The maximum number of operations to pull per read from the remote
cluster.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].parameters.max_outstanding_read_requests</code>
</span>
</dt>
<dd>
(long) The maximum number of outstanding read requests from the remote cluster.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].parameters.max_read_request_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>) The maximum size in bytes of per read of a batch
of operations pulled from the remote cluster.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].parameters.max_write_request_operation_count</code>
</span>
</dt>
<dd>
(integer) The maximum number of operations per bulk write request executed on
the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].parameters.max_write_request_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>) The maximum total bytes of operations per bulk
write request executed on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].parameters.max_outstanding_write_requests</code>
</span>
</dt>
<dd>
(integer) The maximum number of outstanding write requests on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].parameters.max_write_buffer_count</code>
</span>
</dt>
<dd>
(integer) The maximum number of operations that can be queued for writing.
When this limit is reached, reads from the remote cluster are deferred until
the number of queued operations goes below the limit.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].parameters.max_write_buffer_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>) The maximum total bytes of operations that can be
queued for writing. When this limit is reached, reads from the remote cluster
are deferred until the total bytes of queued operations goes below the limit.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].parameters.max_retry_delay</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>) The maximum time to wait before retrying an
operation that failed exceptionally. An exponential backoff strategy is
employed when retrying.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].parameters.read_poll_timeout</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>) The maximum time to wait for new operations on the
remote cluster when the follower index is synchronized with the leader index.
When the timeout has elapsed, the poll for operations returns to the follower
so that it can update some statistics, then the follower immediately attempts
to read from the leader again.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-info-examples"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-info.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This example retrieves follower info:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /follower_index/_ccr/info</pre>
</div>
<div class="console_widget" data-snippet="snippets/1441.console"></div>
<p>The API returns the following results:</p>
<div class="pre_wrapper lang-console-result">
<pre class="programlisting prettyprint lang-console-result">{
    "follower_indices" : [
        {
            "follower_index" : "follower_index",
            "remote_cluster" : "remote_cluster",
            "leader_index" : "leader_index",
            "status" : "active",
            "parameters" : {
                "max_read_request_operation_count" : 5120,
                "max_read_request_size" : "32mb",
                "max_outstanding_read_requests" : 12,
                "max_write_request_operation_count" : 5120,
                "max_write_request_size" : "9223372036854775807b",
                "max_outstanding_write_requests" : 9,
                "max_write_buffer_count" : 2147483647,
                "max_write_buffer_size" : "512mb",
                "max_retry_delay" : "500ms",
                "read_poll_timeout" : "1m"
            }
        }
    ]
}</pre>
</div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="ccr-get-follow-stats.html">« Get follower stats API</a>
</span>
<span class="next">
<a href="ccr-put-auto-follow-pattern.html">Create auto-follow pattern API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>